Skip to content

Fix typo in Quick Start #2695

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 19, 2024

Conversation

ZohairZaidi
Copy link
Contributor

Description

I have made a few grammatical fixes I found while reading the Quick Start Guide. @vaughnbetz please let me know if I have made any errors in the formatting of this pull request for future contributions.

Related Issue

Motivation and Context

Allows the guide to be followed smoothly, improving clarity and consistency

How Has This Been Tested?

Types of changes

  • Bug fix (change which fixes an issue)
  • New feature (change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • My change requires a change to the documentation
  • I have updated the documentation accordingly
  • I have added tests to cover my changes
  • All new and existing tests passed

@github-actions github-actions bot added the docs Documentation label Aug 17, 2024
@vaughnbetz
Copy link
Contributor

Thanks! The changes look good and I don't see any formatting errors (you can see the built documentation by clicking on the link at the bottom of the checks list).

A good follow-on update would be to update the Quick Start guide to say how to run yosys+parmys in addition to Odin II. We're moving to yosys + parmys being the default front end, but haven't updated the quick start guide yet.

@vaughnbetz vaughnbetz merged commit 25dd43d into verilog-to-routing:master Aug 19, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants